Skip to content

docs(claude): fix stale refs, add missing structure entries, trim redundancy#595

Merged
nanotaboada merged 1 commit into
masterfrom
docs/improve-claude-md-accuracy-conciseness
Jun 8, 2026
Merged

docs(claude): fix stale refs, add missing structure entries, trim redundancy#595
nanotaboada merged 1 commit into
masterfrom
docs/improve-claude-md-accuracy-conciseness

Conversation

@nanotaboada

@nanotaboada nanotaboada commented Jun 8, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Owner

Summary

Generated by the CLAUDE.md Management plugin.

  • Fix stale docker-compose.yml reference → compose.yaml in "Ask before changing" (actual filename since Compose Specification v2)
  • Add rest/ (HTTP request file) and gunicorn.conf.py (production WSGI config) to Structure section — both exist at project root but were undocumented
  • Condense "Creating Issues" templates from 18 lines to 4 lines — SDD protocol preserved, verbose field-by-field lists removed
  • Remove redundant commit format block from "After completing work" — format already stated in Commits and Invariants sections

Test plan

  • No code changes — docs only; all 25 tests pass, 98% coverage
  • Verify compose.yaml exists at project root (docker-compose.yml does not)
  • Verify rest/players.rest and gunicorn.conf.py exist at project root (both confirmed)

🤖 Generated with Claude Code

This change is Reviewable

Summary by CodeRabbit

  • Documentation
    • Updated internal development process documentation to reflect current repository structure and Docker configuration references.

@coderabbitai

coderabbitai Bot commented Jun 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f57b4ebc-5440-4b43-9470-37ef99bf1b1e

📥 Commits

Reviewing files that changed from the base of the PR and between 48c9b7c and 343a6eb.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • CLAUDE.md

Walkthrough

This PR updates project documentation in CLAUDE.md to reflect changes in repository structure, Docker configuration, and agent workflow processes. The rest/ directory is added to the structure overview, compose.yaml replaces the outdated docker-compose.yml reference, SDD instructions are expanded with Feature and Bug templates, and commit message format guidance is removed. CHANGELOG.md documents these modifications.

Changes

Documentation Updates

Layer / File(s) Summary
CLAUDE.md project documentation updates
CLAUDE.md		 Added rest/ directory to Structure section for manual API testing, corrected Docker compose filename reference from docker-compose.yml to compose.yaml, expanded Spec-Driven Development instructions with explicit Feature and Bug issue templates and acceptance criteria blocks, and removed embedded commit message format example from the "After completing work" section.
CHANGELOG.md documentation entry
CHANGELOG.md		 Added [Unreleased] → Changed entry documenting all modifications to CLAUDE.md including structure additions, Docker reference correction, template condensation, and commit format block removal.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title follows Conventional Commits format (docs:), is 76 characters (under 80 limit), and accurately describes the main changes: fixing stale docker-compose references, adding missing structure entries, and trimming redundancy.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/improve-claude-md-accuracy-conciseness
  • 🛠️ sync documentation
  • 🛠️ enforce http error handling
  • 🛠️ idiomatic review
  • 🛠️ verify api contract

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@nanotaboada @claude
docs(claude): improve CLAUDE.md accuracy and conciseness
343a6eb 
Generated by the CLAUDE.md Management plugin:
https://claude.com/plugins/claude-md-management

- Fix stale `docker-compose.yml` reference to `compose.yaml` in "Ask
  before changing" (actual filename since Compose Specification v2)
- Add `rest/` and `gunicorn.conf.py` to Structure section — both exist
  at project root but were undocumented
- Condense "Creating Issues" from 18 lines to 4 lines — SDD protocol
  preserved, verbose field-by-field templates removed
- Remove redundant commit format block from "After completing work" —
  format already stated in Commits and Invariants sections

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov

codecov Bot commented Jun 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (48c9b7c) to head (343a6eb).

Additional details and impacted files 
@@            Coverage Diff            @@
##            master      #595   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            7         7           
  Lines          172       172           
=========================================
  Hits           172       172

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nanotaboada nanotaboada force-pushed the docs/improve-claude-md-accuracy-conciseness branch from e865499 to 343a6eb Compare June 8, 2026 17:39
@sonarqubecloud

sonarqubecloud Bot commented Jun 8, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@nanotaboada

nanotaboada commented Jun 8, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 8, 2026 •
edited
Loading

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@nanotaboada nanotaboada merged commit 29dd02c into master Jun 8, 2026
11 checks passed
@nanotaboada nanotaboada deleted the docs/improve-claude-md-accuracy-conciseness branch June 8, 2026 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@nanotaboada